home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / mach10.zip / HPREADER.DOC < prev    next >
Text File  |  1990-06-26  |  8KB  |  233 lines
  1. HPReader
  2. By Scott M. Baker
  3.  
  4.  
  5. What is HPReader?
  6.  
  7.      HPReader is a message reader program that I have written. It is similar
  8. to many other mail reader programs out there (such as Jim Nutt's MSGED or
  9. Front Door's mail reader utility), but it offers a few unique capabilities:
  10.  
  11.       * Dynamic configuration based on your areas.BBS file. HPReader will
  12.         automatically use the AREAS.BBS file definitions rather than it's
  13.         own configuration table. (one less table of areas to maintain)
  14.  
  15.       * Reads area descriptions from ECHOLIST.*. HPReader will load in an
  16.         ECHOLIST file (if present) and get it's area descriptions from that
  17.         file. (one less table of area descriptions to maintain)
  18.  
  19.       * Compatible with both FIDO and HP (High Performance) message formats.
  20.         (The HP format is a new format that I am developing to replace
  21.         the fido standard)
  22.  
  23.       * Supports file requesting and file attaching
  24.  
  25.       * EGA/VGA extended screen length modes
  26.  
  27.       * Full screen editor
  28.  
  29.      Those are most of the features that set HPReader apart form other sysop
  30. mail reader programs. One of the nicest things about HPReader is that HPReader
  31. has very little configuration parameters that need to be set up. (Basically
  32. only a few paths and your net/node address). With other mail ready programs,
  33. you usually have to maintain an additional list of areas/descriptions, but
  34. HPReader automatically loads this information out of the AREAS.BBS and
  35. ECHOLIST.* files.
  36.  
  37.      HPReader DOES NOT support remote users, so therefore, it is only useful
  38. as a sysop message editor.
  39.  
  40.  
  41. What is HPReader compatible with?
  42.  
  43.      HPReader is compatible with the FIDO .MSG message standard. It will
  44. run on both monochrome and color systems, and should work in 300k or less
  45. memory. It supports up to 255 areas. So basically, HPReader should work with
  46. FrontDoor, Binkley, Opus, Fido, EchoDoor, MSGED, Echodor, and a number of
  47. other products that also use the FIDO format.
  48.      HPReader is also developed to use my new HP message format. The HP
  49. format uses an index file and a body file to store all messages in a message
  50. area. Since I have not released my message tosser or my BBS (both are written
  51. to use the HP format), you will probably not need to bother with any of the
  52. HP format information.
  53.  
  54.  
  55. How do I set up HPReader?
  56.  
  57.      Basically, you have to edit HPReader.CTL (which contains all parameters).
  58. You will need to specify the locations of your AREAS.BBS file and optionally
  59. your ECHOLIST.* file. You will also need to specify the location of your
  60. netmail area and you net/node address. The control file is self-explanitory
  61. for it's parameters.
  62.      When you log into HPReader for the first time, HPReader will ask you a
  63. few questions and create a .UDF file for you.
  64.  
  65.  
  66. How do I run HPReader?
  67.  
  68.      After setting HPReader up, all you have to do is type "HPReader" at the
  69. command line and providing HPReader is configured properly, it should load and
  70. display the last read message in your NETMAIL area.
  71.  
  72.  
  73.  
  74. HPREADER COMMANDS
  75. -----------------
  76.  
  77. LEFT-ARROW  Message Forward
  78.  
  79. RIGHT-ARROW Message BackWard
  80.  
  81. UP-ARROW    Scroll message 1 line up
  82.  
  83. DN-ARROW    Scroll message 1 line down
  84.  
  85. PGUP  Page message up
  86.  
  87.         Page-Up will scroll the current message one page up (i.e. towards the
  88.    beginning of the message). If you are at the top of the message, you can
  89.    not scroll any further.
  90.  
  91.  
  92. PGDN  Page message down
  93.  
  94.         Page-Down will scroll the current message one page down (i.e. towards
  95.    the bottom of the message). If you are at the bottom of the message, you
  96.    will not be permitted to scroll any further.
  97.  
  98.  
  99. ALT-A Change Current Area
  100.  
  101.         The ALT-A command will allow you to change message areas. (To either
  102.    one of your echo areas or your netmail area). Selection is made with the
  103.    up and down arrows. Press RETURN to select an area.
  104.  
  105.  
  106. ALT-D Doctor
  107.  
  108.         ALT-D will allow you to do some low-level editing of the message. You
  109.    may change various fields in the header and really screw things up if you
  110.    aren't careful.
  111.  
  112.  
  113. ALT-E Enter Message
  114.  
  115.         You may enter a message with the ALT-E command. You will be prompted
  116.    for who you wish to address the message to and the message's subject. You
  117.    will then be teleported over to the full screen editor and permitted to
  118.    type your message in.
  119.  
  120.  
  121. ALT-F Toggle Flags
  122.  
  123.         You may use ALT-F to toggle the FLAGS of any message. You may set or
  124.    reset any flag (i.e. FileAttach, Private, Crash, etc). You may also toggle
  125.    flags while you are entering the header for a message (via the ALT-R or
  126.    ALT-E commands)
  127.  
  128.  
  129. ALT-H Help
  130.  
  131.         ALT-H will pop up a screen showing a list of the commands that you
  132.    may use. Pressing any key will erase the list and return you back to what
  133.    you were doing.
  134.  
  135.  
  136. ALT-I Toggle Hidden Information
  137.  
  138.         The ALT-I command will toggle whether HPReader will show various
  139.    information such as SEEN-BY and path lines, EID's, MSGID's, etc. Since
  140.    most of this information is quite ugly, HPReader defaults it to be hidden.
  141.  
  142.  
  143. ALT-K Kill message
  144.  
  145.         ALT-K will kill (delete) the current message. You will first be
  146.    prompted to verify the deletion. Once a message is deleted, there is
  147.    no way to recover it (except with an undelete program).
  148.  
  149.  
  150. ALT-R Reply
  151.  
  152.         The ALT-R command will enter a reply to the current message. The
  153.    subject field will be copied from the original message, and the original
  154.    "From" user name will be copied to your "To" user name. You will also
  155.    be prompted for if you wish to quote the original message.
  156.  
  157.  
  158. ALT-S Change Area/Size Graph
  159.  
  160.         Similar to the ALT-A command, this command will can your message areas
  161.    and present you with a sorted listing of the message area sizes. You may
  162.    then select a message area as with ALT-A or browse through the listing.
  163.    This option is handy to see which areas are eating up the most space on
  164.    your drive.
  165.  
  166.  
  167. ESC   Exit
  168.  
  169.         Pressing Escape at any time will save your lastread pointers, exit
  170.    HPReader, and return you to the dos prompt. You may also press ALT-X
  171.    or ALT-Q to exit.
  172.  
  173.  
  174. <num>
  175.  
  176.         Typing a number will allow you to jump to a specific message number
  177.    in the current message area.
  178.  
  179.  
  180. LASTREAD FILES:
  181.  
  182.      Currently, there are three ways the HPReader may keep track of your
  183. lastread pointers. You may use the LASTREAD.BBS files which are present in
  184. your fido message subdirectories, you may use a Mach-10 userbase (My bbs
  185. which isn't yet available), or you may rely on HPReader's .LST files to
  186. preserve your lastread pointers. Here is how to select them:
  187.  
  188.         LASTREAD.BBS
  189.  
  190.               The lastread.bbs files may be selected by specifying LASTREAD
  191.          as your bbs type in your UDF file. (Complete details are inside
  192.          1.UDF)
  193.  
  194.         MACH-10
  195.  
  196.               Since my bbs hasn't been released yet, don't worry about it.
  197.  
  198.         HPREADER *.LST
  199.  
  200.               HPReader will automatically create a .LST file in the current
  201.          directory for each .UDF file. These .LST files contain all of your
  202.          lastread pointers for all of the areas. The .LST files are useful
  203.          in the following situations:
  204.  
  205.                1) You are reading messages in an area that is not supported
  206.                   by your bbs and therefore, your bbs does not have lastread
  207.                   data for the area.
  208.  
  209.                2) Your bbs does not support any other format.
  210.  
  211.  
  212.      For most users, specifying the LASTREAD.BBS format will be the correct
  213. choice.
  214.  
  215.  
  216. .UDF FILES:
  217.  
  218.      HPReader uses .UDF files to keep track of various people who can use
  219. HPReader. HPReader will automatically create a .UDF file for you on your first
  220. logon.
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.